/**
 * The New BSD license is used for the ForD2 RPG (Multi-Layered Framework for
 * Authoring Dungeons and Dragons Based Role Playing Games).
 * Components to provide the largest
 * amount of freedom for developers that want to base their application on this
 * product.
 *
 * Copyright (c) 2007, ForD2 RPG Systems A.S.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of ForD2 RPG Systems A.S. nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package framework.persistence;

import framework.commons.FrameworkUUIDGenerator;

/**
 * This class is a generic implementation of the Persistentable interface to
 * gives the persistent object caracteristcs. Implements Persistentable.
 * @author <B>Marcos Tadeu Silva</B>
 *         e-mail: <I>zero.ufal@gmail.com</I>, 08/31/2007.
 * @version 0.1
 * @since first
 */
public class GenericPersistentable implements Persistentable {
    // constants ------------------------------------------------------------
    
    // properties -----------------------------------------------------------
    
    /**
     * An unique object identifier.
     */
    protected String uid;
    
    // static  --------------------------------------------------------------
    
    // constructors ---------------------------------------------------------
    
    /**
     * Creates a new instance of GenericPersistentable generating the uid.
     */
    public GenericPersistentable() {
        uid = "";
        
        uid = FrameworkUUIDGenerator.getInstance().generate();
    }
    
    // private methods ------------------------------------------------------
    
    // public methods -------------------------------------------------------
    
    /**
     * Sets the uid attribute value.
     * @param uid value to be setted.
     */
    protected void setUid(final String uid) {
        this.uid = uid;
    }
    
    // x override -----------------------------------------------------------

    /**
     * The generic override of hashCode. If uid isn't null or empty,
     * returns the generated uid hashCode, otherwise gets the super hashCode.
     *
     * @return the generated uid hashCode.
     */
    public int hashCode() {
        int result = super.hashCode();
        
        if (uid != null) {
            if (!uid.equals("")) {
                return uid.hashCode();
            }
        }
        
        return result;
    }
    
    /**
     * The generic override of equals. Gets the given parameter object and
     * compare the know uid.
     * @param obj the object to be compared.
     * @return true if the uid is the same and false otherwise.
     */
    public boolean equals(final Object obj) {
        if (obj == null) {
            return false;
        }
        
        if (obj == this) {
            return true;
        }
        
        if (!(obj instanceof GenericPersistentable)) {
            return false;
        }
        
        GenericPersistentable generic = (GenericPersistentable) obj;
        
        if (!generic.uid.equals(this.uid)) {
            return false;
        }
        
        return true;
    }
    
    // y implementation -----------------------------------------------------
    
    /**
     * Gets the value of the uid.
     * @return the value of the genereted uid.
     */
    public String getUid() {
        return uid;
    }
    
    // z inner class --------------------------------------------------------

}
